home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
EnigmA Amiga Run 1995 November
/
EnigmA AMIGA RUN 02 (1995)(G.R. Edizioni)(IT)[!][issue 1995-11][Skylink CD].iso
/
earcd
/
program
/
gcc
/
gcc270-d.lha
/
gnu
/
man
/
cat5
/
man.conf.0
Wrap
Text File
|
1992-08-10
|
4KB
|
133 lines
MAN.CONF(5) UNIX Programmer's Manual MAN.CONF(5)
NNAAMMEE
mmaann..ccoonnff - configuration file for man(1)
DDEESSCCRRIIPPTTIIOONN
The man(1), apropos(1), and whatis(1) commands search for manual pages
or their database files as specified by the mmaann..ccoonnff file. Manual pages
are expected to be preformatted (see nroff(1)) and named with a trailing
``.0''.
The mmaann..ccoonnff file contains two types of lines.
The first type of line is a ``section'' line, which contains a section
name followed by a directory path. Lines in this format specify that
manual pages for the section may be found in the directory.
Directories named with a trailing slash character (``/'') are expected to
contain subdirectories (see the keyword ``_subdir'' below) instead of
manual pages. These subdirectories are searched instead of the directo
ry.
All directories (either explicitly specified or named with a trailing
slash) may contain subdirectories. The man(1) command automatically
searches any subdirectory with the same name as the current machine type
before the directory is searched. No specification of these subdirecto
ries is necessary in the mmaann..ccoonnff file.
Section names are unrestricted except for the reserved words specified
below; in general, however, it is best to avoid anything beginning with
an underscore (``_'') in order to avoid future incompatibilities.
The section named ``_default'' is the list of directories to be searched
if no section is specified.
The second type of line is preceded with a ``keyword''. The possible
keywords and their meanings are as follows:
_subdir
The list (in search order) of subdirectories which will be
searched in any directory named with a trailing slash (``/'')
character. This list is also used when a path is specified by
the MANPATH environment variable or the --MM option.
_version
The version of the configuration file.
_whatdb
The full pathname (not just a directory path) for a database to
be used by the apropos(1) and whatis(1) commands.
Multiple specifications for all types of lines (except for ``_version'')
are cumulative and the entries are used in the order listed in the file;
multiple entries may be listed per line, as well.
Empty lines or lines whose first nonwhitespace character is a hash mark
(``#'') are ignored.
EEXXAAMMPPLLEESS
Given the following mmaann..ccoonnff file:
_version BSD.1
_subdir cat1 cat2 cat3
_default /usr/share/man/
sect3 /usr/share/man/cat3
The default mktemp(3) manual page should be stored in
``_/_u_s_r_/_s_h_a_r_e_/_m_a_n_/_c_a_t_3_/_m_k_t_e_m_p_._0''. Any VAX architecture specific version
of it should be stored in ``_c_a_t_3_/_v_a_x_/_m_k_t_e_m_p_._0''.
The command ``man mktemp'' would search the subdirectories ``_c_a_t_1''
``_c_a_t_2'', and ``_c_a_t_3'', in ``_/_u_s_r_/_s_h_a_r_e_/_m_a_n'', in that order, for
``_m_k_t_e_m_p_._0_'_'_.'' If a subdirectory with the same name as the current ma
chine type existed in any of them, it would be searched as well.
The command ``man sect3 mktemp'' would only search
``/usr/share/man/cat3'' and any possible per machine subdirectory.
FFIILLEESS
/etc/man.conf Standard manual directory search path.
SSEEEE AALLSSOO
apropos(1), machine(1), man(1), whatis(1), whereis(1)
HHIISSTTOORRYY
The mmaann..ccoonnff file format currently under development.
May 10, 1991 2